-
-
Notifications
You must be signed in to change notification settings - Fork 592
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use a table format for list of plugins #872
base: main
Are you sure you want to change the base?
Conversation
:glob: | ||
|
||
* | ||
.. table:: Active Test Plugins |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks prone to merge conflict problems and seems to remove the error code from the specific plugin documentation page.
If we don't care about merge conflicts running rampant, we can do
B101 :doc:`assert_unused <b101_assert_used>` Low High
To not show the error code in the name if we want without losing the error code on the plugin's page... unless we specifically want to start migrating away from the short code format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I originally used the technique you describe, but the width of the lines became obscenely long. I also noticed that each plugin's doc already denotes the bandit ID anyway as their first line like so:
B501: Test for missing certificate validation
So it's already a bit redundant today in how it appears. For example:
https://bandit.readthedocs.io/en/1.7.4/plugins/b501_request_with_no_cert_validation.html
Rather than showing the plugins as a simple list, this change puts them into a table. It also clearly separates active vs. removed plugins for clarity. Also discovered as part of this change was that snmp_weak_cryptography plugin doc file was incorrectly named with the duplicate ID of 508 instead of 509 as it should be. Signed-off-by: Eric Brown <browne@vmware.com>
Rather than showing the plugins as a simple list, this change
puts them into a table. It also clearly separates active vs.
removed plugins for clarity.
Also discovered as part of this change was that snmp_weak_cryptography
plugin doc file was incorrectly named with the duplicate ID of 508
instead of 509 as it should be.
Signed-off-by: Eric Brown browne@vmware.com